<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
    <title>Search Plugin Readme</title>
    <style type="text/css">
        BODY {
            font-size : 100%;
        }
        BODY, TD, TH {
            font-family : tahoma, verdana, arial, helvetica, sans-serif;
            font-size : 0.8em;
        }
        H2 {
             font-size : 10pt;
             font-weight : bold;
        }
        A:hover {
            text-decoration : none;
        }
        H1 {
            font-family : tahoma, arial, helvetica, sans-serif;
            font-size : 1.4em;
            font-weight: bold;
            border-bottom : 1px #ccc solid;
            padding-bottom : 2px;
        }

        TT {
            font-family : courier new;
            font-weight : bold;
            color : #060;
        }
        PRE {
            font-family : courier new;
            font-size : 100%;
        }
    </style>
</head>
<body>

<h1>
LDAP Search Plugin Readme
</h1>

<h2>Overview</h2>
<p>
The search plugin adds Jabber Search <a href="http://www.xmpp.org/extensions/xep-0055.html">XEP-0055</a> 
capabilities to Openfire. This plugin is designed to work with various Jabber clients to allow
other users to search for users currently registered on the same server they are. This plugin only works
when LDAP is configured correctly as the user provider. 
</p>

<h2>Installation</h2>
<p>
Copy the file, &quot;ldapSearch.jar&quot; into the plugins directory of your Openfire installation. The plugin will
then be automatically deployed. To upgrade to a new version: 1) go to the plugin screen of the Admin
Console, 2) click on the delete icon on the same row as the currently installed ldap search plugin, 3) 
copy the new ldapSearch.jar into the plugins directory of your Openfire installation.
</p>

<h2>Configuration</h2>
<p>
The ldap search plugin is configured via the "LDAP Search Properites" sidebar item located under the "Server" tab
in the Openfire Admin Console. The ldap search plugin uses the searchFields property in the ldap section of your
openfire.xml configuration file. Read the official Openfire LDAP Documentation for details on how to configure
that field.
</p>

<h2>Using the Plugin</h2>
<p>
Use of this plugin varies from client to client; however, basic instructions for accessing the search screen
for some of the more popular clients are listed below. On the search screen there is a textfield next to each
search fiel. In the textfield enter all or part of the user's name, username 
and/or email that you want to find. As an example, if you want to find your friend John but don't know
if his last name is spelled "Smith" or "Smyth", try entering "John" in the first name search field and "S*" in 
the last name search field and selecting the AND search type to match both. The "*" symbol acts as a wildcard so your search might return not 
only "John Smith" but all the users whose name begins with "John S", i.e. "John Slater", "John Salazar", etc.

<br>

<li>
Spark - Use the search field along the bottom portion of the main Spark window.
</li>
<br>

<li>
Exodus - After clicking on the magnifying glass with the red "+" sign, a screen will appear displaying the search 
service that will be used which will be used. Click on the "Next" button and the search screen will
be visible.
</li>
<br>

<li>
JAJC - After clicking on the "Jabber Browser" icon (the third icon from the left), a Jabber browser screen will appear and on the right-hand side, there  will be a list of services. Double-click on the "User Search"
entry and a new screen will appear. Finally, on the left-hand side of the screen, click on the "Search" item to view the search screen.
</li>
<br>

<li>
Pandion (v2.1.2) - From the "Actions" menu click on "Add a contact...", on the screen that appears makes sure
the "I want to search for someone." radio button is selected and then click on the "Next >" button to
view the search screen.
</li>
<br>

<li>
Psi - On the lower left-hand corner of the client, click on the main Psi toolbar, select "Service Discovery", and click on your username. After the service discovery windowappears, select the "User Search" entry and  click on
the magnifying glass at the top of the window to view the search screen.
</li>
</p>

<h2>Credits</h2>
<p>
This plugin is based on the works of the original Search plugin for Wildfire, written by Ryan Graham. This plugin was sponsored by Interwise, Inc.
</body>
</html>
